@xml-tools/parser is an npm package that provides tools for parsing XML documents. It allows developers to convert XML strings into a structured format that can be easily manipulated and analyzed in JavaScript. The package is particularly useful for applications that need to process or transform XML data.

What are @xml-tools/parser's main functionalities?

Parsing XML Strings

This feature allows you to parse an XML string into a structured JavaScript object. The `parse` function takes an XML string as input and returns a parsed representation of the XML document.

const { parse } = require('@xml-tools/parser');
const xmlText = '<note><to>Tove</to><from>Jani</from><heading>Reminder</heading><body>Don't forget me this weekend!</body></note>';
const parsedXML = parse(xmlText);
console.log(parsedXML);

Handling Parsing Errors

This feature demonstrates how to handle errors that may occur during the parsing process. The `parse` function will throw an error if the XML string is not well-formed, which can be caught and handled appropriately.

const { parse } = require('@xml-tools/parser');
const xmlText = '<note><to>Tove</to><from>Jani</from><heading>Reminder</heading><body>Don't forget me this weekend!</body></note'; // Note the missing closing '>'
try {
  const parsedXML = parse(xmlText);
  console.log(parsedXML);
} catch (error) {
  console.error('Parsing error:', error.message);
}

Other packages similar to @xml-tools/parser

@xml-tools/parser

A Fault Tolerant XML Parser which produces a Concrete Syntax Tree.

This means that the Parser will not stop on the first error and instead attempt to perform automatic error recovery. This also means that the CST outputted by the Parser may only have partial results. For example, In a valid XML an attribute must always have a value, however in the CST produced by this parser an attribute's value may be missing as the XML Text input is not necessarily valid.

The CST produced by this parser is often used as the input for other packages in the xml-tools scope, e.g:

@xml-tools/ast As the input for building an XML AST.
@xml-tools/content-assist As part of the input for the content assist APIs.

Installation

With npm:

npm install @xml-tools/parser

With Yarn

yarn add @xml-tools/parser

Usage

Please see the TypeScript Definitions for full API details.

A simple usage example:

const { parse } = require("@xml-tools/parser");

const xmlText = `<note>
                     <to>Bill</to>
                     <from>Tim</from>
                 </note>
`;

const { cst, lexErrors, parseErrors } = parse(xmlText);
console.log(cst.children["element"][0].children["Name"][0].image); // -> note

Support

Please open issues on github.

Contributing

See CONTRIBUTING.md.

Keywords

FAQs

What is @xml-tools/parser?

Is @xml-tools/parser well maintained?

Package last updated on 03 Jun 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install